R.T.F.M.

ist die Abkürzung für ReadTheFuckingManual und bedeuted soviel wie: Lies die verdammte Anleitung. Leider wird den mühevoll erstellten Dokumentationen viel zu wenig Beachtung geschenkt und wenn dann einmal etwas nicht sofort funktioniert, wird der Autor mit den ewig gleichen Fragen bombardiert, welche zumeist ohnedies in der Anleitung bereits behandelt wurden.

Die Dokumentationen berüchtigter PC-Anwendungen sind da allerdings nicht so vorbildlich, wie wir es am Amiga gewohnt sind. Da zahlt man lockere 8000 Schillinge für ein Zeichenprogramm, welches nix wirklich kann und bei jeder dritten Operation, dies ist keine Übertreibung, sondern ein tatsächliches Erlebnis, semmelt und dabei teilweise sogar noch andere Applikationen und manchmal sogar noch das ganze NT4 mit in den Abgrund reißt. Wie sieht nun die Dokumentation eines solchen Programmes aus? Es gibt die normale Hilfe, die ist ebenso umfangreich und realitätsbezogen wie die fünfteilige Trilogie von "The Hitchhikers Guide To The Galaxy", dabei aber meistens wesentlicher schlechter übersetzt. Neben der Hilfe gibt es noch eine Fülle an readme Dateien, versteckt in unzähligen Unterverzeichnissen, mit teilweise widersprüchlichem Inhalt und, in Bezug auf Aussagekraft und Eindeutigkeit, eines Finanzministers würdig. Die gedruckten Manuals sind auch nicht viel besser: umfangreich wie Stephen Kings "Green Mile", klar und eindeutig wie das Gilgameschepos und, wenn es um Problemlösung geht, genauso gesprächig wie das Orakel in Delphi. Ein neuer Trend ist es, die Dokumentation in den Installationsvorgang einzugliedern, man darf also gleich nach der Installation lesen, ob des Programm auch so ohne weiteres funktionieren wird. Das ist toll.

Schätzen wir uns also wieder einmal glücklich, denn wir dürfen schon vor der Installation die Dokumentation lesen.

[Yam]

Links das Programm selbst, in der Mitte die Amigaguide-Datei und rechts eine Textdatei. Die Textdatei enthält meist letzte Änderungen und die History, die Geschichte der Änderungen. Sehen wir uns einmal die Amigaguide Datei genauer an: (Bitte Grafik an-klicken!)

Die Einteilung der einzelnen Punkte erfolgt nach einer logischen und einfachen Struktur. Zuerst eine kurze Einleitung, welche beschreibt was das Programm kann, darunter die Requirements, dort steht, was das Programm braucht und anchließend die Copyright Information. Damit wissen wir bereits vor der eigentlichen Installation, ob wir das Programm brauchen können oder nicht.

Danach folgt die Beschreibung der Installation, welche fast immer über den Installer (siehe AmigaScene 0x02) erfolgt, und eine Kurzeinführung, gefolgt von einer weiterführenden Erklärung der einzelnen Programmfunktionen. Darauf aufbauend erfolgt eine Beschreibung der weniger offensichtlichen Programmabläufe, wobei allgemeine Regeln und plattformunabhängige Normen in weiterer Folge ebenso detailliert erkärt werden. Am Schluß stehen noch die Zukunftspläne, Danksagungen und die Adresse des Autors.

Die Dokmentation ist also wie ein Schulaufsatz gegliedert in Einleitung, Hauptteil und Schluß. Zusätzlich sind die einzelnen Themen untereinander verlinkt, was an der buttonartigen Hervorhebung einzelner Begriffe zu erkennen ist. Klickt man auf so einen Button, erhält man eine Erklärnung des Begriffes. Mit den Navigationsbuttons im obersten Teil des Amigaguide-Fensters wird das Bewegen durch die Dokumentation zusätzlich erleichtert.

Wie sieht nun so eine Amigaguide-Datei aus? Wie alles auf unserem Amiga: Geschrieben in ASCII, logisch aufgebaut und genau so einfach in der Erstellung wie in der Handhabung.

@database AmigaScene.guide @$VER: AmigaScene.guide 1.0a (5.Mar.98) @author "Stephan J. Bischoff"

Das sind die ersten Zeilen, wobei @ darauf hinweist, daß der Rest der Zeile als Kommando zu interpretieren ist. Grundsätzlich arbeitet Amigaguide mit sogennanten nodes, das sind einzelne Textseiten, welche untereinander verlinkt werden können. Am wichtigsten dabei ist main, die Startseite. Ein node sieht wie folgt aus:

@node "Main" "Amigascene 0x03"

"Main" bezeichnet den Namen der aktuellen node und "Amigascene 0x03" ist der Windowtitel der aktuellen Seite.

Hier steht dann der auszugebende Text wobei man auch @{b} bold text @{ub} oder @{i} italic Text @{ui} oder @{i}@{b} BEIDES @{ui}@{ub} ausgeben kann.

Und nun definieren wir uns einen Link-Button mit der Bezeichnung "TEST" zur node testlink:

@{" TEST " link "testlink"}

Damit schliessen wir das node main und machen weiter unten das node testlink auf.

@endnode @node "testlink" "Testlink"

Schon sind wir da. Und mit einem Klick auf

@{" Main " link "Main"}

können wir wieder zurückspringen zur node Main.

@endnode

Eine Dokumentation ist also schnell erstellt und man kann sich dabei auf das Wesentliche konzentrieren. Im Vergleich zu den bunten PC-Betriebsystemen sparen wir uns also Zeit beim Erstellen der Dokumentation, beim Lesen, beim Support und nicht zuletzt, beim Installieren und können sie gewinnbringend, zum Beispiel zum Tortenbacken, nutzen.

Stephan Bischoff ...........

....